gdk: Clarify the docs of gdk_keyval_to_unicode
authorMatthias Clasen <mclasen@redhat.com>
Mon, 22 Jun 2020 17:24:34 +0000 (13:24 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Mon, 22 Jun 2020 17:24:34 +0000 (13:24 -0400)
Explicitly state that the conversion does not
take locale into account, and point out GDK_KEY_KP_Decimal
as a candidate for special-casing.

gdk/gdkkeyuni.c

index 863d2b4935895df3ee88050d041f161363aa1d33..77261de6bf094a02b9599e7000bce83dc4784ae5 100644 (file)
@@ -878,11 +878,15 @@ static const struct {
 
 /**
  * gdk_keyval_to_unicode:
- * @keyval: a GDK key symbol 
- * 
+ * @keyval: a GDK key symbol
+ *
  * Convert from a GDK key symbol to the corresponding ISO10646 (Unicode)
  * character.
- * 
+ *
+ * Note that the conversion does not take the current locale
+ * into consideration, which might be expected for particular
+ * keyvals, such as %GDK_KEY_KP_Decimal.
+ *
  * Returns: the corresponding unicode character, or 0 if there
  *               is no corresponding character.
  **/